home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 26 / Cream of the Crop 26.iso / bbs / kdom221.zip / KDOC-TXT.ZIP / KCOORD.TXT next >
Text File  |  1997-06-15  |  39KB  |  781 lines

  1.  
  2.         ┌──────────────────────────────────────────────────────┐
  3.         │                       KINGDOMS                       │
  4.         ├──────────────────────────────────────────────────────┤
  5.         │          NETWORK COORDINATOR DOCUMENTATION           │
  6.         │                     Version 2.21                     │
  7.         ├──────────────────────────────────────────────────────┤
  8.         │                                                      │
  9.         │  Programming & Design : Dave Chapman : The Web BBS   │
  10.         │                                                      │
  11.         │   Copyright c 1993, 94, 95, 96, 97 - Dave Chapman    │
  12.         │                 All Rights Reserved                  │
  13.         │                                                      │
  14.         │       3:712/523@FidoNet  169:3005/2@BattleNet        │
  15.         │                                                      │
  16.         ├──────────────── kingdoms@tpgi.com.au ────────────────┤
  17.         │                                                      │
  18.         │              - Kingdoms Support Page -               │
  19.         │        http://www1.tpgi.com.au/users/kingdoms        │
  20.         │                                                      │
  21.         └──────────────────────────────────────────────────────┘
  22.  
  23.  
  24.                            TABLE OF CONTENTS
  25.                            ─────────────────
  26.  
  27. SECTION 1 : COORDINATOR OVERVIEW
  28.  
  29.         1.1. Document Purpose
  30.         1.2. So you want to be a Coordinator?
  31.         1.3. Network Overview
  32.                 1.3.1. Technical
  33.         1.4. Terms and Definitions
  34.                 1.4.1. The Index
  35.                 1.4.2. Routing Rules
  36.                 1.4.3. Default Outbound
  37.                 1.4.4. Network Id
  38.  
  39. SECTION 2.0. UP & RUNNING
  40.  
  41.         2.1. Overview
  42.         2.2. Choosing a Network ID
  43.         2.3. Creating An Index
  44.         2.4. Adding Nodes
  45.         2.5. Modifying Nodes
  46.         2.6. Deleting Nodes
  47.         2.7. Reactivating Nodes
  48.         2.8. Index File Dump
  49.         2.9. Resetting the Game
  50.                 2.9.1. Overview
  51.                 2.9.2. Issuing a Reset
  52.                         2.9.2.1. Resetting a Realm
  53.                         2.9.2.2. Resetting a League
  54.                 2.9.3. How It's Done
  55.         2.10. Coordinator Log
  56.         2.11. Link Diagram
  57.         2.12. Net Connections
  58.  
  59. SECTION 3.0. TRACKING PROBLEMS
  60.  
  61. APPENDIX A : NEW NODE APPLICATION
  62.  
  63.  
  64. Section 1 : Coordinator Overview
  65.  
  66. 1.1. Document Purpose
  67.  
  68. This document explains what it is to be a Kingdoms Coordinator (known as
  69. a League Coordinator, or LC) and what tasks a LC does. If you're not a
  70. Coordinator and are not thinking of becoming one, then there's no need
  71. for you to read this to run Kingdoms on your BBS.
  72.  
  73. 1.2. So you want to be a Coordinator? 
  74.  
  75. A Coordinator is the person who manages a Kingdoms network. Kingdoms
  76. makes this task pretty easy by automating all network management
  77. functions, but there's still a lot to do just keeping track of new
  78. applications on your network and managing problems that will arise time
  79. to time. The Coordinator carries out the following tasks on a Kingdoms
  80. network.
  81.  
  82. * Creates and maintains the Index, which is a list of all nodes in the
  83.   League.
  84. * Accepts new applications for BBS's that want to join the network.
  85. * Issues game resets when required/desired.
  86. * Is responsible for monitoring and correcting mail problems in the
  87.   network, via the Coordinator maintenance options.
  88. * Delete old or inactive nodes on the network.
  89. * Generally keep things flowing as they should!
  90.  
  91. That's only an overview, but you get the picture! If you think you want
  92. to get into all this and get a good network going, then read on!
  93.  
  94. 1.3. Network Overview
  95.  
  96. 1.3.1. Technical
  97.  
  98. A Kingdoms Network consists of a series of BBS's running Kingdoms and
  99. communicating with each other via standard Netmail conventions. Each BBS
  100. in the Network is known as a Realm. Kingdoms directly supports and can
  101. address up to 35,000 Realms connected in one distinct network. In each
  102. network there is ONE Coordinator node. All other nodes are equal in this
  103. respect. Limited network diagnostic utilities (Worms and Routing
  104. Reports) are available to a standard Kingdoms node, but only the
  105. Coordinator node can issue the advanced network management commands to
  106. directly affect the network as a whole, such as adding, deleting or
  107. modifying individual nodes.
  108.  
  109. Each Realm in the Network must have configured an external mailer to
  110. which Kingdoms can define file- attached netmail messages in the .MSG
  111. format, such as FrontDoor or Blinkey supports. A switch is available
  112. also in the outbound manager to support the Blinkey/Squish mailer file
  113. attach message format. Obviously, a new Realm coming into the game must
  114. have a link to another Realm for mail transfer and a valid network
  115. address through which their respective mailers can communicate. Unlike
  116. many other InterBBS games, it is quite permissable for each node in a
  117. Kingdoms network to be on a different network. Eg, one Realm can use a
  118. Fidonet address like 3:712/523 and the next an AdultLink address,
  119. 69:1171/200. As long as the mailers communicate, it doesn't matter to
  120. Kingdoms what network it's creating outbound and processing inbound
  121. files for. It will manage each seamlessley.
  122.  
  123. Note that the Coordinator node need not be central in terms of a network
  124. `picture' in any way. As far as connections are concerned, it matters
  125. only that the Coordinator, through some path, is connected to all other
  126. nodes. The Coordinator Realm may be a central mail hub, or a node way
  127. down a mail feed line.
  128.  
  129. 1.4. Terms and Definitions
  130.  
  131. To get the most out of this document and run your network at it's best,
  132. you'll need to understand the following terms :
  133.  
  134. 1.4.1. The Index
  135.  
  136. Each BBS in your network must have an Index file, called KIDX.DAT. It
  137. must reside in the `Game Directory', as defined in the Kingdoms Manager
  138. for each BBS. If an Index is not found or it is empty, Kingdoms will
  139. refuse to enter the InterBBS options for players. The Index is
  140. effectively the `nodelist' for your network and is created and updated
  141. by you, the Kingdoms coordinator. The Index has one record for each BBS
  142. and holds (or is updated with) the following information.
  143.  
  144. 1.      The Game name of each BBS in the network
  145. 2.    The Game name of the Sysop running each BBS
  146. 3.    The actual BBS address (Zone, Net, Node. Points are not supported)
  147. 4.    The BBS type, Normal, Default or Routed
  148. 5.    A counter for incrementing outbound file names for that BBS
  149. 6.    Most recent Recon date
  150. 7.    Mail type, Hold or Direct, Crash or No-Crash
  151. 8.    Time statistics, to and from, for each BBS
  152. 9.    Status : Active, Inactive, Pending or Deleted
  153. 10.     Default Connection Zone, Net, Node
  154.  
  155. I will discuss fully what these things mean later, but for now just be
  156. aware that the Index exists and that it is used to define to each system
  157. what BBS's are in the network and who routes data to whom.
  158.  
  159. 1.4.2. Routing Rules
  160.  
  161. Routing Rules are rules specified by each Sysop for their BBS. They tell
  162. Kingdoms where to send mail to for each node.
  163.  
  164. 1.4.3. Default Outbound
  165.  
  166. When each Sysop in the network defines their node to the Index during
  167. setup, a Default Outbound is assigned based on the network connections
  168. you have defined which are held in each Index on each Realm. Relative to
  169. each node, Kingdoms will set the Default Outbound as the outbound which
  170. is the shortest (or only) available uplink to you, the Coordinator node.
  171. The Self Correction facilities in Kingdoms 2.15 and later will poll the
  172. Default Outbound at intervals specified by each Sysop in the `Other'
  173. section of the Manager. This ensures the integrity of the network is
  174. maintained by propogating changes that might have been missed through
  175. the normal update channels when you actually make changes to the
  176. network.
  177.  
  178. 1.4.4. Network Id
  179.  
  180. Each Kingdoms network must have a unique Id. This is a two character
  181. code that is used to ensure that the inbound files that Kingdoms
  182. processes actually belong to the Leagu they're in. It also allows an
  183. individual BBS to play in two (or more) different Kingdoms networks (ie,
  184. run two separate Kingdoms games in different Leagues) without each
  185. getting confused about which mail to direct to which game on their BBS.
  186. Please note that though any combination of letters and numbers (not
  187. special characters) may be used in the Net Id for your League, it is not
  188. case sensitive. Thus, Kingdoms will consider Net Id "1a" as being the
  189. same league as Net Id "1A'.
  190.  
  191. SECTION 2.0. Up & Running
  192.  
  193. 2.1. Overview
  194.  
  195. Following are the basics of what a Coordinator needs to do to get a
  196. network up and running and to maintain it. The remainder of the document
  197. goes into detail about what each of these things mean if you want
  198. further information. Everything done here is achieved using the general
  199. and Coordinator functions in the Kingdoms Manager :
  200.  
  201. - Select a unique Network ID for your network.
  202. - Define your own node using Generate Index.
  203. - Add Pending nodes (nodes coming online soon)
  204. - Generate Indexes for the Pending Nodes (so they can set themselves up)
  205. - Release Pending nodes (make them active across the network)
  206. - Modify node details (as required)
  207. - Deactivate nodes for whatever reason when required.
  208. - Reset the game network wide when needed.
  209. - Check problems using Routing reports and Worms.
  210.  
  211. You may want to wing it from here, but I suggest reading the rest if you
  212. REALLY want to understand what you're doing as a Kingdoms Coordinator.
  213.  
  214. 2.2. Choosing a Network ID
  215.  
  216. In the Manager, you will have seen a place you can enter a `Network ID'.
  217. If you are playing in an existing network, this is normally provided for
  218. you. As a Coordinator however, you must select your own for your network
  219. and make sure everyone in your network knows what it is and has entered
  220. it correctly. If they have it wrong, Kingdoms on their system will not
  221. process data from your network.
  222.  
  223. The Network ID is simply a means of tagging network mail as belonging to
  224. your game (your network) rather than another. That way, data doesn't get
  225. processed by nodes outside your network and/or using another Kingdoms
  226. network as well as yours.
  227.  
  228. The NetID is used primarily in two places - KNetIn and KNetOut. The way
  229. these are used will be explained shortly, but first it is advisable to
  230. understand how file names are created by Kingdoms -
  231.  
  232. The format of a Kingdoms outbound file name is "KNxxxyyy.zza" where :
  233.  
  234.     KN     - A fixed prefix, standing for Kingdoms Network.
  235.     xxx    - The BBS index number which created the file.
  236.     yyy    - The BBS index number the file is destined for.
  237.     zz    - The Network ID of the data in the file.
  238.     a    - Check character to avoid duplicate filenames.
  239.  
  240. Thus, the file `KN003006.FAC' is a Kingdoms Network file going from BBS
  241. 3 and destined for BBS 6, ie, the 3rd and 6th BBS's listed in the Index
  242. file. The file contains data for the Kingdoms network with ID `FA' and
  243. has a unique identifier of `C'. The next outbound from BBS 3 would be
  244. named `KN003006.FAD', & so on.
  245.  
  246. The 003 and 006 are really meaningless to Kingdoms itself as it does not
  247. care who is sending data to whom as far as filenames go. This naming
  248. convention has been chosen for Kingdoms Sysops to be able to see at a
  249. glance what data is going where without having to edit files and search
  250. out origin addresses, destination addresses, etc etc.
  251.  
  252. The part of the file name we want to talk about here however is the
  253. Network ID. As discussed, it is part of the filename of outbounds
  254. created by any Kingdoms system. When you choose the ID for your network,
  255. you must NOT choose one that has special characters in it, or other
  256. characters that are not valid characters in a DOS file name. To be
  257. completely safe, I recommend you stay with alphabetic characters and
  258. numbers. Case is not sensitive thus `Aa', `aa' and `aA' are, to
  259. Kingdoms, the same Network ID. In full, valid characters in a Network
  260. ID's are the letters A through Z and numbers 0 through 9 inclusive and
  261. the characters underscore, _, carat, ^, dollar, $, tilde, ~,
  262. exclamation, !, number, #, percent, %, ampersand, &, hyphen, -, braces,
  263. {}, parenthesis, (), at, @, apostrophe, `, and grave accent, `.  No
  264. other special characters are acceptable and your Network ID ***MUST
  265. NOT*** contain spaces, commas, backslashes, periods or question marks.
  266.  
  267. To summarise all that, the network ID is used to generate outbound file
  268. names. It must therefore be made up of characters which are valid in a
  269. DOS filename. It must also be exactly two characters in length. As
  270. discussed, the network ID should be unique. This is to stop mail from
  271. your network getting muddled with mail that should be for another
  272. network. How you make it unique is a harder question when you can't know
  273. what everyone else is using, but I suggest you check with those nodes
  274. that are in and/or joining your network. As long as they aren't using
  275. the one you want already for another network, you're probably OK. A
  276. complete list of all the NetId's I hear about/know of is maintained on
  277. the Kingdoms support page on the Net -
  278. http://www1.tpgi.com.au/users/kingdoms.
  279.  
  280. A file is also available on my BBS for FREQ under the magic name
  281. `KNETID' which lists all the currently used Network ID's that I've been
  282. told about. I urge you to FREQ a copy of this or check out the Web site
  283. and choose a Network ID not already in use elsewhere in the world. That
  284. done, then mail me (crash, net, internet, whatever) the one you've
  285. chosen and I'll add it to KNETID so others can make sure they don't use
  286. yours!
  287.  
  288. 2.3. Creating An Index
  289.  
  290. This is where you'll first use your Coordinator options in the Manager.
  291. As most people don't need to see them (in fact, only the Coordinator
  292. can) they're not selectable by the normal arrow keys. To get to the
  293. Coordinator options, you must specifically press Alt-C to bring up the
  294. Coordinator menu. When selected, you'll have the following options
  295. available :
  296.  
  297.         - Generate Index
  298.         - Add a new node
  299.         - Enable a new Node
  300.         - Modify a node
  301.         - Delete a node
  302.         - Reactivate a Node
  303.         - Index File Dump
  304.         - Reset the Game
  305.         - Cancel a Reset
  306.         - Coordinator Log
  307.         - Link Diagram
  308.         - Net Connections
  309.  
  310. To make your Index, choose the first option, `Generate Index' by
  311. pressing Enter when it is highlighted. It's assumed here that you do NOT
  312. have an index (KIDX.DAT) file in your Kingdoms directory. If you do, you
  313. must remove it before trying to create a brand new index. If one does
  314. exist, the Generate Index option behaves differently and will offer you
  315. the option of generating a Distribution index from the existing one the
  316. Manager found. Generating a distribution index is discussed shortly
  317. however - for now, we'll assume there is not one there.
  318.  
  319. After choosing Generate Index, a window will pop up asking you for your
  320. node information. You're required to enter your network address, BBS
  321. name and Sysop name. This data is needed and used to create the first
  322. entry in your new index file. Your entry will also be tagged as the
  323. Coordinator node. A couple of points to note here :
  324.  
  325.   * You MUST give your valid network address. When Kingdoms creates
  326.   outbound packets from your BBS to others, this address is used as the
  327.   originating address. If it's not valid, other nodes will proabably
  328.   reject or misprocess your mail.
  329.  
  330.   * The BBS name and Sysop name you give here do NOT have to be the same
  331.   as the ones you entered in the <O>ther submenu of the File drop down
  332.   menu in the Manager. You can enter anything you like here. The names
  333.   you enter here are the names seen by players in the game across the
  334.   network. You are free to make them something more interesting (or
  335.   obscure!) than your real BBS/Sysop name for the sake of interest in
  336.   the game. This applies to the names of all systems in your League.
  337.  
  338. That's all there is to creating your Index File. Press Esc when you've
  339. entered all the information correctly and confirm the data is correct.
  340. Your new index file (KIDX.DAT) will be created with one Realm in it,
  341. your own, tagged as the Coordinator Realm.
  342.  
  343. 2.4. Adding Nodes
  344.  
  345. Once created you will, of course, want to add other nodes to it. Adding
  346. nodes is a two step process. When you first add a new node, it does not
  347. actually get activated or distributed immediately. Rather, it is placed
  348. on your index only (not distributed across the network) as a PENDING
  349. Node. The reason for this is to facilitate the creation of Distribution
  350. Index files. I shall take a moment out to explain this. When a new Realm
  351. (BBS) comes onto your network, that Realm will need an index file in
  352. order to set themselves up. Of course, that index file must contain
  353. their BBS, or they're not going to get far. Who wants a nodelist that
  354. doesn't list their own node? You could just add the new node (without
  355. having the `Pending' concept) and send them a copy of the Index from
  356. your own system, but that will cause problems for two reasons :
  357.  
  358. 1.      Firstly, your own Index probably already has your own routing
  359. rules defined in it. If you give other nodes a copy of your own index,
  360. the rules will be all wrong for them and it will be very confusing for a
  361. new Kingdoms sysop!
  362.  
  363. 2.      Also, if the node becomes active immediately rather than being a
  364. Pending node, then players on your BBS, and others in the network when
  365. the new node is distributed by Kingdoms, will doubtless start sending
  366. recons to it and trying to communicate with the new node when it appears
  367. on the Realms lists in the game itself. Most likely, that node is only
  368. just setting itself up and is not ready to receive mail, if it's linked
  369. to it's Kingdoms feed at all!
  370.  
  371. Instead of causing these problems, the PENDING node is created. In PEND
  372. status, a Realm does not appear in your game Realm listings, nor is the
  373. new node distributed to other Realms already active in your network. In
  374. short, it doesn't exist yet to players in your game or to other Realms
  375. at all, but it IS on YOUR, the Coordinator's, Index file. What you can
  376. do at this point is use the `Generate Index' option again, as you did
  377. when you first created the Index for your own Coordinator node. Because
  378. an Index already exists this time, Kingdoms will assume that you do not
  379. want to generate a completely new index. Instead, it will create for you
  380. a Distribution Index file, which is a copy of your existing Index
  381. including PENDING nodes, with all routing fields initialised to zero or
  382. blanks, as appropriate. This you can send to your new nodes and they
  383. will have a fully initialised, up-to-date Index, which DOES have their
  384. node listed. They can set themselves up and when they're ready you can
  385. Enable the Pending node, which will make that Realm active (listed and
  386. usable by players in the game) on your Realm in addition to distributing
  387. an Index update to all other Realms, making the new Realm active across
  388. the net also without further action required on your behalf. The
  389. Distribution Index file is created as KIDX.id, where nn is the Network
  390. ID as defined in the <O>ther section of the Manager. It is not, of
  391. course, called KIDX.DAT, as that would overwrite your existing Index
  392. file!
  393.  
  394. So, to summarise the process of generating and Index and adding nodes to
  395. your network:
  396.  
  397. * Create an new Index (using Generate Index) with your node information.
  398. Obviously, this only ever needs to be done once!
  399.  
  400. * Add a node (using Add Node) which will be set to Pend status.
  401.  
  402. * Create a distribution index file for your new node(s) (using Generate
  403. Index).
  404.  
  405. * Get the distribution index to the new node, or have them pick it up.
  406.  
  407. * When the new node is ready, release the Pending node to the network
  408. (using Enable Node).
  409.  
  410.  
  411. When you choose Add Node, you'll need to provide the following
  412. information for each node you want to add :
  413.  
  414. * The new BBS address (Zone:Net/Node)
  415. * The Game BBS Name
  416. * The Game Sysop Name
  417. * The `Connect To' site.
  418.  
  419. Items 1 thru 3 should be obvious, but item 4 requires some explanation.
  420. The `Connect To' site is simply the BBS who the new BBS is going to pick
  421. up mail from. As Coordinator you should have this information already as
  422. anyone joining your network will need to have already decided a point
  423. they'll pick up Kingdoms mail from and informed you where their pickup
  424. is during their application.
  425.  
  426. As discussed, this info will be retained as a Pending node on your
  427. Index. Other than choosing (and confirming) the Enable Node option from
  428. your coordinator menu, there is NOTHING more you need to do to make the
  429. new node active across your entire League. Once you Enable the node, the
  430. following will take place, all internally & automatically through your
  431. Kingdoms network.
  432.  
  433. 1. An outbound record will be generated for each ACTIVE BBS in your
  434. Index. When each outbound arrives at it's destination, each
  435. destination's Index files will be updated automatically with the new
  436. node during Kingdoms inbound processing. The routing rules defined for
  437. new new node on each BBS are evaluated intelligently based on the
  438. `Connect To' node you specified originally, ensuring mail is routed to
  439. the new node properly by each BBS in the network. This information (and
  440. any changes you make to it later) are saved in the Index on each Realm.
  441. This data can be used later by the Sysop's to restore your `Default'
  442. configuration should they need to do so. The Sysop on each of these
  443. BBS's need not even know that a new node has been added, yet the game
  444. will know of it, recognise it and route to it seamlessley. An entry will
  445. also appear in the game news files informing players of the
  446. arrival/existence of the new Realm.
  447.  
  448. 2. Your local index file will be updated to reflect the change. Ie, the
  449. Pending status on the node in your Index will be changed to Active.
  450.  
  451. A few safety nets and warning systems exist here for you :
  452.  
  453. 1. If for some reason the `Connect To' node is not listed on a BBS's
  454. index, the new node will have it's information routed to the Default
  455. Outbound node, as defined for that BBS. While not as sure as a `Connect
  456. To' node, it is a likely bet that this will adequately route the mail to
  457. where it should be going.
  458.  
  459. 2. As well as 1 above if the `Connect To' isn't found, a netmail message
  460. is sent by Kingdoms back to you, the Coordinator, informing you of a
  461. problem with that node. The problem is, of course, that they don't have
  462. a node on their Index that should be there. In such cases, you may want
  463. to get them to pick up another copy or your distribution Index or
  464. distribute another node addition to make sure they're up- to-date in
  465. case a previous addition got lost or misprocessed for some reason.
  466.  
  467. 3. If the node already exists, the add will be aborted and a netmail
  468. message returned to the Coordinator informing him or her of the
  469. situation. This perhaps isn't a problem, but that is best determined by
  470. yourself should you find it has happened.
  471.  
  472. 2.5. Modifying Nodes
  473.  
  474. Modifying nodes is also a simple matter under Kingdoms.  For any node in
  475. your Index, you can distribute changes to any node's Sysop Name, BBS
  476. Name and/or address.
  477.  
  478. As you may be aware, a system's real Sysop & BBS names are used to match
  479. up with Kingdoms registration numbers.  You may think therefore that you
  480. shouldn't change a Sysop name & BBS name or a registered node will
  481. suddenly find it's rego key no longer matches these fields. This is not
  482. the case. What you are modifying if you do this are those names in the
  483. INDEX file, not in the remote Realm's configuration file. Index file
  484. searches are based on address only, not Sysop/BBS name, so anything
  485. really can be placed in this field without affecting Kingdoms adversley.
  486. For example, `Dave Chapman' on `The Web BBS' in the Web's configuration
  487. could be called `Draken Noir' on `Dragons Lair' on the Index (and thus
  488. have the Realm known as DragonsLair, network wide) without a problem.
  489.  
  490. These name fields can be changed as often and as much as you like, but
  491. try to minimise use of the facility, particularly for the BBS name. It
  492. can get confusing to players if a Realm they're used to seeing there
  493. changes name all the time.
  494.  
  495. Changing the BBS Address is done in much the same way. You simply choose
  496. the C>hange N>ode functions in the manager, then type in the modified
  497. address.  When you confirm your changes, the modifications are
  498. automatically distributed to the network for you. The address change on
  499. all Realms, including your own, will automatically set up an Alias for
  500. the old address on each node so mail in transit - even though it's
  501. destination may be the old address when the change takes place on each
  502. Realm - is smoothly routed to the correct (new) address.
  503.  
  504. 2.6. Deleting Nodes
  505.  
  506. Similar to adding a new node, there are two steps to deleting a node on
  507. your network. The first delete you issue for a particular node does not
  508. actually delete the node. Instead, it marks it `Inactive'. This way you
  509. can `turn someone off' without having to re-add them at a later stage
  510. should you change your mind. The node will stay Inactive until another
  511. Delete order is issued by the coordinator, or until it is returned to
  512. normal operation, again by you, the LC. Of course, setting a node
  513. Inactive will set it Inactive on ALL Realms, not just on your own.
  514.  
  515. If at some stage you decide you really do want to delete the node,
  516. simply issue a second Delete Node request for that Realm. On all realms
  517. in the network, the node will be irrevocably deleted. If you want to
  518. bring it back at this stage, you will have to go through the Add Node
  519. procedure.
  520.  
  521. A few notes on deleting a node :
  522.  
  523. * An Inactive node is simply ignored by Kingdoms completely for all
  524. things. Maintenance will not request recons from it, Inbounds from it
  525. (eg, Invasions) will be ignored and not processed, Players will not see
  526. it and will not be able to select it for activity.
  527.  
  528. * It doesn't matter how long you leave an Inactive node inactive for. It
  529. will stay in that status until you either issue another delete for it or
  530. until you re-activate it.
  531.  
  532. * The options `Enable a new node' and `Reactivate a node' are different.
  533. You `Enable' a Pending node to make it active. You `Reactivate' an
  534. Inactive (deleted once) node to bring it back up on the Network.
  535.  
  536. 2.7. Reactivating Nodes
  537.  
  538. It is quite possible that you've deleted a node for whatever reason and
  539. find later (before you've issued another delete and removed it
  540. permanently!) that you want to make it active again. This option will do
  541. that for you. When selected, it will give you a list of all Realms in
  542. your Index that are marked `Inactive'. Simply highlight the node you
  543. want to reactivate and press Enter. Upon confirming this is what you
  544. want to do, the node will be reactivated on your Index file, and an
  545. instruction will be sent to all other nodes to do the same. Unless you
  546. do something further to the node, it will again be an active Realm, just
  547. like any other.
  548.  
  549. 2.8. Index File Dump
  550.  
  551. This option is there simply so that, should you want to, you can get a
  552. `raw' dump of your Index file. All info pertinent to each node is
  553. provided nicely formatted and can be printed or used as you wish.
  554. Obviously, this is a dump of the file only - changing data here will NOT
  555. be reflected back in the real Index file in any way.
  556.  
  557. An example of an Index Dump for the Battlenet League (Netid 59) looks
  558. like :
  559.  
  560. Kingdoms 2.19 Index File Dump for Net 59. 12-08-1996 (1996343) at 13:31:50.
  561. ====== ============== ============================== ================ =====
  562. Record BBS Address    Realm Name                     Your Routing     Mail 
  563.        Node Status    Realm Sysop                    Last Recon     
  564.                                                      Network Connect
  565. ====== ============== ============================== ================ =====
  566.      1 169:3800/5     RADAR'S wRECk ROOM             This Node        N/A
  567.        Co-Ord         Radar                          No Recon 
  568.                                                      0:0/0          
  569. ------ -------------- ------------------------------ ---------------- -----
  570.      2 169:3800/1     MAX                            Default Outbound Hold
  571.        Active         Peter Connerty                 No Recon 
  572.                                                      169:3800/5     
  573. ------ -------------- ------------------------------ ---------------- -----
  574.                           ... more nodes ...
  575. ------ -------------- ------------------------------ ---------------- -----
  576.     20 169:3300/6     Enterprise BBS                 169:3800/1     N/A
  577.        Active         Andrew Seeger                  No Recon 
  578.                                                      169:3300/1     
  579. ------ -------------- ------------------------------ ---------------- -----
  580.  
  581. The fields for each Realm include :
  582.  
  583. * Record Number : The actual record number of the Realm on the Index File.
  584. * Address       : The address of the Realm - Zone/Net:Node
  585. * BBS Name      : The BBS Name shown on the Index to players
  586. * Your Routing  : Where your node actually routes data to for the respective
  587.                   Realm
  588. * Mail Type     : Hold or Direct. Only applicable for outbound nodes
  589. * Node Status   : Coord, Active, Inactive, Deleted, Pending.
  590. * Sysop         : The Sysop Name shown on the Index to players
  591. * Last Recon    : The date a Recon was last recieved from this Realm, or No
  592.                   Recon.
  593. * Connection    : Where the node is physically connected to on the network.
  594.  
  595. 2.9. Resetting the Game
  596.  
  597. 2.9.1. Overview
  598.  
  599. As you may be aware, any individual Sysop can reset their Kingdoms game
  600. at any time by using the /RESET parameter on KMNT. As the Coordinator
  601. Realm you can do this also, but you also have the power to issue a Reset
  602. on a NETWORK WIDE basis. The reset can take place on a certain day
  603. anywhere between five and 100 days (inclusive) in the future.
  604.  
  605. 2.9.2. Issuing a Reset
  606.  
  607. When you choose the `rEset the Game' option, you will be asked if you
  608. want to reset your entire League, or just a specific Realm.
  609.  
  610. 2.9.2.1. Resetting a Realm
  611. Resetting a Specifid Realm is a very powerful function and should be
  612. used with caution. It is irreversable once issued, is immediate (when
  613. the instruction reaches the Realm in question, it cannot be cancelled
  614. and will happen as soon as Maintenance runs on that Realm) and cannot be
  615. overridden using the /NORESET switch in KMNT by the remote Sysop.  I
  616. don't think further explanation is necessary here - choosing this will
  617. fully reset the Kingdoms game running on the Realm chosen once you
  618. confirm and issue the instruction. As you may appreciate, this is a good
  619. vehicle for bringing errant Sysops into line if all else fails. :-)
  620.  
  621. 2.9.2.2. Resetting a League
  622.  
  623. Having selected a League reset, you will be asked the date you want a
  624. reset to take place. Because this is such an important option, you must
  625. give the date in very precise format - dd-mm/ccyy (day/month/century-
  626. year), including zeros where appropriate. The first of March, 1996 then
  627. would be entered as 01-03-1996. NO other format will be permissable and
  628. the date entry routine checks for leap years as well to ensure no
  629. invalid dates are accepted.
  630.  
  631. Having chosen a date, you will be asked if you want nodes to return a
  632. message to you to acknowledge receipt of the reset instruction. It's a
  633. good idea to do so as this will allow you to make sure everyone received
  634. it properly, but you don't have to request receipts if you don't want
  635. them. If you do, all nodes that receive the reset command and process
  636. the instruction will send a message back to you which will appear in
  637. your Coordinator's log (NOT in the game logs), telling you it was
  638. accepted and confirming the appropriate date.
  639.  
  640. Lastly, the reset info will be redisplayed to ensure you have it right
  641. and responding `yes' to the final confirm will issue the Reset
  642. instruction network wide.
  643.  
  644. Two things will happen to let Kingdoms players on all realms know of the
  645. impending League Reset. Firstly, a message will be placed in the game
  646. news files when the reset command is received. On your local realm, of
  647. course, this will appear in the news immediately. On each day when there
  648. are five days or less remaining before the reset, another message will
  649. appear in the `Todays News' file for the players stating it's due, and
  650. how many days remain before the Reset takes place. This should give
  651. players ample notice that it's coming!
  652.  
  653. 2.9.3. How It's Done
  654.  
  655. As you may have gathered, KMNT is the vehicle by which a Reset is
  656. achieved. When it runs, KMNT will always check for a pending reset (you
  657. can always look yourself at F)ile->O)ther in the Manager for a reset
  658. date if one is due) and when the day comes around, it will Reset the
  659. game rather than running the normal maintenance process.
  660.  
  661. The process is fairly simple on the local Realm. The User file is
  662. initialised, the message base trashed etc etc. All Outbound packets are
  663. also deleted to get rid of network traffic belonging to the `old' game.
  664. A few problems and issues are evident here however, which will now be
  665. examined/explained :
  666.  
  667. * In a Leage Reset situation, Sysop's on individual boards may override
  668. a Coordinator's Reset by using the /NORESET parameter in KMNT. Also, the
  669. system may simply be down or have some error on the day the Reset is due
  670. and for that reason it may simply not run. For this reason, KMNT will
  671. continue to attempt to honor a Coordinator Reset indefinately each time
  672. maintenance runs after the reset is due, if the reset has not already
  673. been done. This should give ample time for those systems with problems
  674. to correct them, run maintenance, and have the Reset processed as it
  675. should be. In the case where a Sysop overrides the Reset, Kingdoms will
  676. send a message back to the Coordinator (which will appear in the
  677. Coordinator log) informing him or her of the situation. You may have
  678. wanted that to happen, in which case you can deal with it as you see
  679. fit. Otherwise, you can contact the Sysop directly to find out why this
  680. has happened and to request them to remove the override. If they still
  681. won't do it for some reason, it is perfectly within the Coordinator's
  682. power to disable the Realm network wide as incencitve. A Sysop can't
  683. override that command. :-)
  684.  
  685. * Due to time zone differences and such also, it is quite possible for
  686. data to be floating around the network that is not removed during the
  687. Reset. To solve this, no data will be accepted by inbound processing
  688. excluding Recon and Network Timing requests/responses for 20 days after
  689. the reset date on any Realm. Any such data will simply be deleted as it
  690. arrives, thus clearing the network of old traffic.
  691.  
  692. 2.10. Coordinator Log
  693.  
  694. This option gives you immediate access to your Coordinator Log. All
  695. Coordinator Activity is recorded in this log and time stamped so you can
  696. keep track of what changes you've made to the network and when. Because
  697. you may want to keep this some time to maintain an historical record of
  698. past events, maintenance will NEVER trim or roll over this log as it
  699. does the newsfiles. You can, of course, delete it or rename it
  700. (KCOORD.LOG) at any time if you wish - Kingdoms will just recreate it
  701. when it needs to write something to it if it isn't already there.
  702.  
  703. 2.11. Link Diagram
  704.  
  705. Particularly useful for the Coordinator, though it's also available to
  706. Sysops on their Network menu as well, the Link Diagram creates a
  707. `picture' of your network, based on the Default network links specified
  708. in the Index. This is a very handy means of both seeing at a glance who
  709. you have connected to who on the network and verifying all links are as
  710. they should be. More information, as it pertains to the Sysop's point of
  711. view, is available in the Manager documentation under the section titled
  712. `Link Diagram' which may be of interest.
  713.  
  714. 2.12. Net Connections
  715.  
  716. This option allows you to change the default connections of any node in
  717. the network. This change is propogated to ALL Index files on all Realms
  718. in your network of course, not just your own. While very simple to use,
  719. it is an extremely powerful function as it is the crux of automating
  720. network routing in Kingdoms. When you change a network connection
  721. (simply by selecting the new node a realm connects to), the change data
  722. will be propogated to all nodes in the network. Upon receipt of the
  723. change, the inbound processor on each node will apply it and re-evaluate
  724. ALL connections to optimize the routing definitions on the node and
  725. bring into effect any changes required by the new connection rules.
  726.  
  727. SECTION 3.0. TRACKING PROBLEMS
  728.  
  729. To you, the Kingdoms Coordinator, it is particularly important that you
  730. are able to track network problems. Realms may go offline for any number
  731. of reasons that may not even be their own fault. For example, a Realm
  732. feeding another Kingdoms data may simply set their routing incorrectly,
  733. meaning that realm never gets its data. Both Worms and Routing Rules are
  734. powerful options that can help you track these types of errors. They are
  735. covered fully in the Sysop documentation, KSYSOP.DOC, so I won't talk
  736. about them again here. Please refer to that document if you need to know
  737. more about them.
  738.  
  739. Several Coordinators have asked me how to tell what node is running what
  740. version of Kingdoms. FYI, as of version 2.19,  a Worm report returns
  741. current Kingdoms version numbers for all Realms through which they pass.
  742. Previously, this information was only available (and still is) by
  743. sending a routing report specifically to the node you wanted to know
  744. about.
  745.  
  746. Appendix A : New Node Application
  747.  
  748. You may use the form below as your formal `application' form for joining
  749. your Kingdoms network. All people need to is fill it in then send it to
  750. you. It contains all the information you need to add a BBS to your
  751. Index.
  752.  
  753.  
  754.        ----------------------------------------------------------
  755.  
  756.                Kingdoms Network Node Addition Application
  757.  
  758.  
  759. BBS Name         : ____________________________________
  760.  
  761.  
  762. Sysop Name        : ____________________________________
  763.  
  764.  
  765. Address            : ________ : ________ / ________
  766.  
  767.  
  768. Connect To         : ________ : ________ / ________
  769.  
  770.  
  771. NetID (if known)        : __________
  772.  
  773. This form is used to gain access to a Kingdoms network. You should crash
  774. it through to your Coordinator who will process your addition and see it
  775. is added to all nodes in the index.
  776.  
  777.        ----------------------------------------------------------
  778.  
  779.                   - End of Coordinator Documentation -
  780.  
  781.